Skip Headers

Oracle® Database JPublisher User's Guide 10g Release 2 (10.2) Part Number B14188-01 |
Home | Book List | Contents | Index | Master Index | Feedback

Previous | Next
| View PDF

# Preface

This preface introduces you to the Oracle Database JPublisher User's Guide, discussing the intended audience, structure, and conventions of this document. A list of related Oracle documents is also provided.

The JPublisher utility is for Java programmers who want classes in their applications to correspond to SQL or PL/SQL entities or server-side Java classes. In Oracle Database 10g, JPublisher also provides features supporting Web services call-ins to the database and call-outs from the database.

This preface covers the following topics:

- Intended Audience

- Documentation Accessibility

- Structure

- Related Documents

- Conventions

## Intended Audience

The Oracle Database JPublisher User's Guide is intended for Java Database Connectivity (JDBC) and Java2 Platform, Enterprise Edition (J2EE) programmers who want to accomplish any of the following for database applications:

- Create Java classes to map to SQL user-defined types, including object types, `VARRAY` types, and nested table types

- Create Java classes to map to `OPAQUE` types

- Create Java classes to map to PL/SQL packages

- Create client-side Java stubs to call server-side Java classes

- Publish SQL queries or data manipulation language (DML) statements as methods in Java classes

- Create Java and PL/SQL wrappers for Web services client proxy classes

- Publish server-side SQL, PL/SQL, or Java entities as Web services

To use this document, you need knowledge of Java, Oracle Database, SQL, PL/SQL, and JDBC.

## Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at

`http://www.oracle.com/accessibility/`

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

TTY Access to Oracle Support Services

Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.

## Structure

This document contains:

Chapter 1, "Introduction to JPublisher"

Introduces the JPublisher utility by way of examples, lists new features in this release, and provides an overview of JPublisher operations.

Chapter 2, "Using JPublisher"

Describes how you can use JPublisher for publishing SQL and PL/SQL objects, Oracle Stream Advanced Queue (AQ), server-side Java classes, and Web services.

Chapter 3, "Data Type and Java-to-Java Type Mappings"

Provides details of JPublisher data type mappings and the styles mechanism for Java-to-Java type mappings.

Chapter 4, "Generated Classes and Interfaces"

Discusses details and concepts of the classes, interfaces, and subclasses generated by JPublisher, including how output parameters (PL/SQL `IN OUT` or `OUT` parameters) are treated, how overloaded methods are translated, and how the generated classes and interfaces are used.

Chapter 5, "Additional Features and Considerations"

Covers additional JPublisher features and considerations: a summary of support for Web services, filtering of JPublisher output, and migration and backward compatibility.

Chapter 6, "Command-Line Options and Input Files"

Provides details of the JPublisher command-line syntax, command-line options and their usage, and input file format.

Appendix A, "Generated Code Examples"

Contains code examples that are too lengthy to fit conveniently with corresponding material earlier in the manual. This includes examples of Java-to-Java type transformations to support Web services, and Java and PL/SQL wrappers to support Web services.

Appendix B, "Troubleshooting"

Covers the troubleshooting tips for JPublisher

## Related Documents

For more information, see the following Oracle resources.

From the Oracle Java Platform group, for Oracle Database releases:

- Oracle Database Java Developer's Guide

  This book introduces the basic concepts of Java in Oracle Database and provides general information about server-side configuration and functionality. It contains information that pertains to the Oracle Database Java environment in general, rather than to a particular product, such as JDBC.

  The book also discusses Java stored procedures, which are programs that run directly in Oracle Database. With stored procedures (functions, procedures, and triggers), Java developers can implement business logic at the server level, which improves application performance, scalability, and security.

- Oracle Database JDBC Developer's Guide and Reference

  This book covers programming syntax and features of the Oracle implementation of the JDBC standard. This includes an overview of the Oracle JDBC drivers, the details of the Oracle implementation of JDBC 1.22, 2.0, and 3.0 features, and a discussion of Oracle JDBC type extensions and performance extensions.

From the Oracle Java Platform group, for Oracle Application Server releases:

- Oracle Application Server Containers for J2EE User's Guide

- Oracle Application Server Containers for J2EE Services Guide

- Oracle Application Server Containers for J2EE Security Guide

- Oracle Application Server Containers for J2EE Servlet Developer's Guide

- Oracle Application Server Containers for J2EE Support for JavaServer Pages Developer's Guide

- Oracle Application Server Containers for J2EE JSP Tag Libraries and Utilities Reference

- Oracle Application Server Containers for J2EE Enterprise JavaBeans Developer's Guide

From the Oracle Server Technologies group:

- Oracle XML DB Developer's Guide

- Oracle XML Developer's Kit Programmer's Guide

- Oracle Database XML Java API Reference

- Oracle Database Application Developer's Guide - Fundamentals

- Oracle Database Application Developer's Guide - Large Objects

- Oracle Database Application Developer's Guide - Object-Relational Features

- Oracle Database PL/SQL Packages and Types Reference

- Oracle Database PL/SQL User's Guide and Reference

- Oracle Database SQL Reference

- Oracle Database Net Services Administrator's Guide

- Oracle Database Advanced Security Administrator's Guide

- Oracle Database Globalization Support Guide

- Oracle Database Reference

Note: Oracle error message documentation is available in HTML only. Only if you have access to the Oracle Documentation CD, you can browse the error messages by range. After you find the specific range, use the Find in Page feature of your browser to locate the specific message. When connected to the Internet, you can search for a specific error message using the error message search feature of the Oracle online documentation.

From the Oracle Application Server group:

- Oracle Application Server 10g Administrator's Guide

- Oracle HTTP Server Administrator's Guide

- Oracle Application Server 10g Performance Guide

- Oracle Application Server 10g Globalization Guide

- Oracle Application Server Web Cache Administrator's Guide

- Oracle Application Server Web Services Developer's Guide

- Oracle Application Server 10g Upgrading to 10g (9.0.4)

From the Oracle JDeveloper group:

- JDeveloper online help

- JDeveloper documentation on the Oracle Technology Network:

      http://otn.oracle.com/products/jdev/content.html

Printed documentation is available for sale in the Oracle Store at

`http://oraclestore.oracle.com/`

To download free release notes, installation documentation, white papers, or other collateral, please visit the Oracle Technology Network (OTN). You must register online before using OTN. Registration is free and can be done at

`http://otn.oracle.com/membership/`

If you already have a user name and password for OTN, then you can go directly to the documentation section of the OTN Web site at

`http://otn.oracle.com/documentation/`

For additional information, see:

    http://jcp.org/aboutJava/communityprocess/final/jsr101/index.html

The preceding link provides access to the Java API for XML-based RPC, JAX-RPC 1.0 specification, with information about JAX-RPC and holders.

    http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/native2ascii.html

For Java Development Kit (JDK) users, the preceding link contains `native2ascii` documentation, including information about character encoding that is supported by Java environments.

## Conventions

This section describes the conventions used in the text and code examples of this documentation set. It describes:

- Conventions in Text

- Conventions in Code Examples

Conventions in Text

We use various conventions in text to help you quickly identify special terms. The following table describes these conventions and provides examples of their use.

Convention | Meaning | Example
--- | --- | ---
Bold | Bold typeface indicates terms defined in the text. | A class is a blueprint that defines the variables and the methods common to all objects of a certain kind.
Italics | Italic typeface indicates book titles and emphasis. | Oracle Database Concepts Ensure that the recovery catalog and target database do not reside on the same disk.
`UPPERCASE monospace (fixed-width) font` | Uppercase monospace typeface indicates system elements. Such elements include parameters, privileges, data types (including user-defined types), RMAN keywords, SQL keywords, SQL*Plus or utility commands, packages and methods, as well as system-supplied column names, database objects and structures, user names, and roles. | You can specify this clause only for a `NUMBER` column. You can back up the database by using the `BACKUP` command. Query the `TABLE_NAME` column in the `USER_TABLES` data dictionary view. Use the `DBMS_STATS`.`GENERATE_STATS` procedure.
`lowercase monospace (fixed-width) font` | Lowercase monospace typeface indicates executables, file names, directory names, and some user-supplied elements. Such elements include computer and database names, net service names, and connect identifiers, as well as Java packages and classes, program units, and parameter values. Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown. | Enter `sqlplus` to start SQL*Plus. The password is specified in the `orapwd` file. Back up the data files and control files in the `/disk1/oracle/dbs` directory. The `department_id`, `department_name`, and `location_id` columns are in the `hr.departments` table. Set the `QUERY_REWRITE_ENABLED` initialization parameter to `true`. The `JRepUtil` class implements these methods.
`lowercase italic monospace (fixed-width) font` | Lowercase italic monospace font represents placeholders or variables. | You can specify the `parallel_clause`. Run `old_release``.SQL` where `old_release` refers to the release you installed prior to upgrading.

Conventions in Code Examples

Code examples illustrate Java, SQL, PL/SQL, SQL*Plus, or command-line statements. They are displayed in a monospace (fixed-width) font and separated from normal text as shown in this example:

    SELECT username FROM dba_users WHERE username = 'MIGRATE';

The following table describes typographic conventions used in code examples and provides examples of their use.

Convention | Meaning | Example
--- | --- | ---
    [ ]
| Brackets enclose one or more optional items. Do not enter the brackets. |
    DECIMAL (digits [ , precision ])
    { }
| Braces enclose two or more items, one of which is required. Do not enter the braces. |
    {ENABLE | DISABLE}
    |
| A vertical bar represents a choice of two or more options within brackets or braces. Enter one of the options. Do not enter the vertical bar. |
    {ENABLE | DISABLE}
    [COMPRESS | NOCOMPRESS]
    ...
| Horizontal ellipsis points indicate either: That we have omitted parts of the code that are not directly related to the example That you can repeat a portion of the code |
    CREATE TABLE ... AS subquery;

    SELECT col1, col2, ... , coln FROM employees;
Other notation | You must enter symbols other than brackets, braces, vertical bars, and ellipsis points as shown. |
    acctbal NUMBER(11,2);
    acct    CONSTANT NUMBER(4) := 3;
    Italics
| Italicized text indicates placeholders or variables for which you must supply particular values. |
    CONNECT SYSTEM/system_password
    DB_NAME = database_name
    UPPERCASE
| Uppercase typeface indicates elements supplied by the system. We show these terms in uppercase in order to distinguish them from terms you define. Unless terms appear in brackets, enter them in the order and with the spelling shown. However, because these terms are not case-sensitive, you can enter them in lowercase. |
    SELECT last_name, employee_id FROM employees;
    SELECT * FROM USER_TABLES;
    DROP TABLE hr.employees;
    lowercase
| Lowercase typeface indicates programmatic elements that you supply. For example, lowercase indicates names of tables, columns, or files. Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown. |
    SELECT last_name, employee_id FROM employees;
    sqlplus hr/hr
    CREATE USER mjones IDENTIFIED BY ty3MU9;